Vcenter ResourcePool FilterSpec

The Vcenter ResourcePool FilterSpec schema contains properties used to filter the results when listing resource pools (see GET /vcenter/resource-pool). If multiple properties are specified, only resource pools matching all of the properties match the filter.

JSON Example

{
    "resource_pools": [
        "string"
    ],
    "names": [
        "string"
    ],
    "parent_resource_pools": [
        "string"
    ],
    "datacenters": [
        "string"
    ],
    "hosts": [
        "string"
    ],
    "clusters": [
        "string"
    ]
}

array of string

resource_pools

Optional

Identifiers of resource pools that can match the filter.

If missing or null or empty, resource pools with any identifier match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ResourcePool. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ResourcePool.

array of string

names

Optional

Names that resource pools must have to match the filter (see Vcenter ResourcePool Info.name).

If missing or null or empty, resource pools with any name match the filter.

array of string

parent_resource_pools

Optional

Resource pools that must contain the resource pool for the resource pool to match the filter.

If missing or null or empty, resource pools in any resource pool match the filter.

array of string

datacenters

Optional

Datacenters that must contain the resource pool for the resource pool to match the filter.

If missing or null or empty, resource pools in any datacenter match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Datacenter. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Datacenter.

array of string

hosts

Optional

Hosts that must contain the resource pool for the resource pool to match the filter.

If missing or null or empty, resource pools in any host match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

array of string

clusters

Optional

Clusters that must contain the resource pool for the resource pool to match the filter.

If missing or null or empty, resource pools in any cluster match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ClusterComputeResource.